Result Codes

All ATSUI functions return result codes of type OSStatus. This includes general result codes such as noErr, indicating that the function completed successfully, and paramErr, indicating that you either passed the function an invalid input parameter value or passed NULL for all output parameters. ATSUI functions that allocate memory may return memFullErr if there is not enough memory in the designated heap.

The result codes specific to ATSUI are listed in Table 2-1. In some cases, the function result section for a particular function provides more detail about the meaning of the result code specific to that function.

Table 2-1 ATSUI-specific result codes

Result code constant	Value	Description
`kATSUInvalidTextLayoutErr`	-8790	Text layout object not previously initialized or in an otherwise invalid state. Available beginning with ATSUI 1.0.
`kATSUInvalidStyleErr`	-8791	Style object not previously initialized or in an otherwise invalid state. Available beginning with ATSUI 1.0.
`kATSUInvalidTextRangeErr`	-8792	Text range extends beyond the limits of the text layout object's text range. Available beginning with ATSUI 1.0.
`kATSUFontsMatched`	-8793	Character could not be rendered with its assigned font. Available beginning with ATSUI 1.0.
`kATSUFontsNotMatched`	-8794	Character could not be rendered with its assigned font or any currently active font. Available beginning with ATSUI 1.0.
`kATSUNoCorrespondingFontErr`	-8795	Font ID corresponds to an existing font that isn't available to ATSUI. Available beginning with ATSUI 1.0.
`kATSUInvalidFontErr`	-8796	Font ID does not correspond to any installed font. Available beginning with ATSUI 1.0.
`kATSUInvalidAttributeValueErr`	-8797	Invalid or undefined attribute value. Available beginning with ATSIU 1.0.
`kATSUInvalidAttributeSizeErr`	-8798	Allocated attribute value size is less than required. Available beginning with ATSUI 1.0.
`kATSUInvalidAttributeTagErr`	-8799	ATSUI-reserved tag value or wrong type of attribute tag (that is, style run attribute tag instead of text layout attribute tag and vice versa). Available beginning with ATSUI 1.0.
`kATSUInvalidCacheErr`	-8800	Attempt to read in style data from an invalid cache (that is, the format of the cached data does not match that used by ATSUI or the cached data is corrupt). Available beginning with ATSUI 1.0.
`kATSUNotSetErr`	-8801	Style object's attribute, font feature, font variation not set; text layout object or single line's attribute not set; or font name not set. Available beginning with ATSUI 1.0.
`kATSUNoStyleRunsAssignedErr`	-8802	No style runs assigned to text layout object. Available beginning with ATSUI 1.1.
`kATSUQuickDrawTextErr`	-8803	QuickDraw function `DrawText` encountered an error rendering or measuring a line of text. Available beginning with ATSUI 1.1.
`kATSULowLevelErr`	-8804	Error encountered in Apple Type Solution (ATS) while performing an operation requested by ATSUI. Available beginning with ATSUI 1.1.
`kATSUNoFontCmapAvailableErr`	-8805	`'CMAP'` table cannot be accessed or synthesized for a font set by the function `ATSUSetAttributes`. Available beginning with ATSUI 1.1.
`kATSUNoFontScalerAvailableErr`	-8806	No font scaler available for a font set by the function `ATSUSetAttributes.` Available beginning with ATSUI 1.1.
`kATSUCoordinateOverflowErr`	-8807	Passed in coordinate values caused coordinate overflow (greater than 32K). Available beginning with ATSUI 1.1.
`kATSULineBreakInWord`	-8808	Not an error code. Returned by `ATSUBreakLine` to indicate that `ATSUBreakLine` performed a line break within a word. Available beginning with ATSUI 1.2.
`kATSULastErr`	-8809	No ATSUI-related result codes may exceed this value. Result code values between `kATSUInvalidTextLayoutErr` and `kATSULastErr` are reserved. Available beginning with ATSUI 1.0.

VERSION NOTES

This enumeration is available beginning with ATSUI 1.0. Additional constants added with ATSUI 1.1 and 1.2.